Entity Light
Light is the Entity definition for a light object.
Subclass of Entity.
Functions
| GetColor1 () | GetColor1 returns the first color used for the light. |
| GetColor2 () | GetColor2 returns the second color used for the light. |
| GetRateChange () | GetRateChange returns the rate of change of the light in msec. |
| GetArc () | GetArc returns the arc over which the light source shines. |
| GetIntensityStringPos () | GetIntensityStringPos returns the current location in the intensity string for the light. |
| GetIntensityStringPos () | GetIntensityString returns the string used to vary intensity of the light. |
| GetRadius () | GetRadius returns the radius of the light effect. |
| GetHighBound () | GetHighBound returns the high bound for the light (unknown). |
| GetLowBound () | GetLowBound returns the low bound for the light (unknown). |
| GetFogAlpha () | GetFogAlpha returns the intensity of fog effect. |
| OnOffSwitch () | OnOffSwitch returns true if the light is on. |
| IsNightOnly () | IsNightOnly returns true if the light is on during night only. |
| IsRepeating () | IsRepeating returns true if the light pattern repeats. |
| IsUseColor2 () | IsUseColor2 returns true if the light uses the secondary color. |
| IsUseArc () | IsUseArc returns true if the light uses the arc value. |
| IsUseFog () | IsUseFog returns true if the light uses the fog value. |
Functions
- GetColor1 ()
-
GetColor1 returns the first color used for the light.
Returns:
-
A table with "r", "g", and "b" members indicating light color components (each is numeric from 0.0 to 1.0).
- GetColor2 ()
-
GetColor2 returns the second color used for the light.
Returns:
-
A table with "r", "g", and "b" members indicating light color components (each is numeric from 0.0 to 1.0).
- GetRateChange ()
-
GetRateChange returns the rate of change of the light in msec.
Returns:
-
An integer indicating the rate of change of the light.
- GetArc ()
-
GetArc returns the arc over which the light source shines.
Returns:
-
An integer indicating the arc of the light in degrees.
- GetIntensityStringPos ()
-
GetIntensityStringPos returns the current location in the intensity string for the light.
Returns:
-
An integer indicating the current offset in the intensity string.
- GetIntensityStringPos ()
-
GetIntensityString returns the string used to vary intensity of the light.
Returns:
-
A string indicating the pattern of intensity change for the light.
- GetRadius ()
-
GetRadius returns the radius of the light effect.
Returns:
-
A numeric value indicating the radius.
- GetHighBound ()
-
GetHighBound returns the high bound for the light (unknown).
Returns:
-
A numeric value indicating the high bound.
- GetLowBound ()
-
GetLowBound returns the low bound for the light (unknown).
Returns:
-
A numeric value indicating the low bound.
- GetFogAlpha ()
-
GetFogAlpha returns the intensity of fog effect.
Returns:
-
A numeric value indicating the fog level.
- OnOffSwitch ()
-
OnOffSwitch returns true if the light is on.
Returns:
-
A boolean indicating if the light is on.
- IsNightOnly ()
-
IsNightOnly returns true if the light is on during night only.
Returns:
-
A boolean indicating if the light is on during night only.
- IsRepeating ()
-
IsRepeating returns true if the light pattern repeats.
Returns:
-
A boolean indicating if the light pattern repeats.
- IsUseColor2 ()
-
IsUseColor2 returns true if the light uses the secondary color.
Returns:
-
A boolean indicating if the light uses both defined colors.
- IsUseArc ()
-
IsUseArc returns true if the light uses the arc value.
Returns:
-
A boolean indicating if the light uses the arc value.
- IsUseFog ()
-
IsUseFog returns true if the light uses the fog value.
Returns:
-
A boolean indicating if the light uses the fog value.